Get Customers Brief Details (V2)

This request retrieves a list of existing customers for the Live Cloud instance including all license types. For additional details (see Get Full Customer Details).

URI

Copy 
{{baseUrl}}/api/v2/customer

HTTP Method

GET

Example Response

Copy 
[
    {
        "Id": "0ad77c8d-c023-4054-ac4e-07d02b4b07a6",
        "ShortName": "royDY",
        "FullName": "royDR",
        "LicenseType": 0
    },
    {
        "Id": "cd631436-a12c-4f79-ae81-099af3f3a0e2",
        "ShortName": "royDRw",
        "FullName": "royDRw",
        "LicenseType": 0
    },
    {
        "Id": "92e58f93-ee65-4c1d-b4e5-12989ca00530",
        "ShortName": "bahir",
        "FullName": "bahir",
        "LicenseType": 0
    },
    {
        "Id": "57162b6e-1ffd-4a60-b05a-1369c936cb9d",
        "ShortName": "ai0logicsDRESS",
        "FullName": "ai0logicsDRESS",
        "LicenseType": 0
    },
    {
        "Id": "f1d30c8d-5f44-451e-9257-2318808ba0df",
        "ShortName": "BB175Plus",
        "FullName": "BB175Plus",
        "LicenseType": 1
    },
    {
        "Id": "020298d1-3d4d-498e-aafa-250774ba12a6",
        "ShortName": "jfsdr",
        "FullName": "jfsdr",
        "LicenseType": 1
    },
    {
        "Id": "0d3e4dd6-ed30-4656-8601-27396a26e594",
        "ShortName": "24124",
        "FullName": "24124 walter pro",
        "LicenseType": 2
    },
    {
        "Id": "be06b468-f12b-47b6-9d1b-44439e6b1c56",
        "ShortName": "BBSuperPro745",
        "FullName": "BBSuperPro745",
        "LicenseType": 2
    },
    {
        "Id": "a1204e1b-5bcc-4268-9803-5ee71ea61817",
        "ShortName": "BB653",
        "FullName": "BB653",
        "LicenseType": 0
    },
    {
        "Id": "46070fae-2c04-481b-a9c0-65a960efafe8",
        "ShortName": "BBEssentials",
        "FullName": "BBEssentials",
        "LicenseType": 0
    },
    {
        "Id": "b51e49d0-4514-4b74-aff1-8a9af62bbd55",
        "ShortName": "BBTokenTest",
        "FullName": "BBTokenTest",
        "LicenseType": 2
    },
    {
        "Id": "6718aed2-6051-4235-9dd5-8ef185092efe",
        "ShortName": "TobiService",
        "FullName": "Tobi's Service",
        "LicenseType": 2
    },
    {
        "Id": "1bae9fd6-1110-4536-9b1e-96a0f61e32e8",
        "ShortName": "RanjSB1",
        "FullName": "RanjanSB1 Demo",
        "LicenseType": 2
    },
    {
        "Id": "bd46801a-c276-495e-9e2c-3d943b4186a6",
        "ShortName": "Ess84",
        "FullName": "Ess84",
        "LicenseType": 0
    },
    {
        "Id": "7e8b8fc3-6705-4fe2-ba11-40481886403e",
        "ShortName": "M365x25192084",
        "FullName": "M365x25192084",
        "LicenseType": 2
    },
    {
        "Id": "c9ef5155-b42c-438a-abe1-a9468e46daaa",
        "ShortName": "BHT_NG_APP",
        "FullName": "BHT_TEST_NG_APP",
        "LicenseType": 2
    },
    {
        "Id": "b2e179fc-6fb4-4926-a792-c1a992ae64c0",
        "ShortName": "audcdk",
        "FullName": "audcdk",
        "LicenseType": 2
    },
    {
        "Id": "fee306b4-4e1c-41e4-bf86-c28435860cbc",
        "ShortName": "BB84EssPlus",
        "FullName": "BB84EssPlus",
        "LicenseType": 1
    },
    {
        "Id": "20bcd945-7d2e-4912-97e4-cfe285d7e1e7",
        "ShortName": "24124_ess",
        "FullName": "24124 walter essential",
        "LicenseType": 0
    },
    {
        "Id": "acea6943-02de-4a77-8963-d777096f007e",
        "ShortName": "roywsba",
        "FullName": "royw enterprise SBA",
        "LicenseType": 2
    },
    {
        "Id": "b1399e6f-0177-49e4-a621-d8e63ec5aeec",
        "ShortName": "BBSuperPlus",
        "FullName": "BBSuperPlus",
        "LicenseType": 1
    },
    {
        "Id": "2ada8357-5cb2-4ba7-8aa8-d9c2cab19af6",
        "ShortName": "BB175Pro",
        "FullName": "BB175Pro",
        "LicenseType": 2
    },
    {
        "Id": "b8aca05a-d5b2-4f58-93ae-ee90c8abb0be",
        "ShortName": "AlbertodemoDR",
        "FullName": "Alberto Hidalgo demo DR",
        "LicenseType": 1
    },
    {
        "Id": "b94947b3-4f28-47a0-9404-f86ad3e90e0b",
        "ShortName": "BBEssentials1",
        "FullName": "BBEssentials1",
        "LicenseType": 0
    },
    {
        "Id": "85a94403-8e21-4579-9e86-f99679def273",
        "ShortName": "BBTest2",
        "FullName": "BBTest2",
        "LicenseType": 2
    },
    {
        "Id": "e1ba6b46-cbb9-4181-b1bd-9fa1e2927b4d",
        "ShortName": "BradSB1E",
        "FullName": "BradSB1E",
        "LicenseType": 0
    },
    {
        "Id": "182f496c-0aaa-4023-bdd4-03b9cf8f68b9",
        "ShortName": "BradSB1E1",
        "FullName": "BradSB1E1",
        "LicenseType": 0
    },
    {
        "Id": "e6a4687d-3572-4340-9bf6-bdfbc3127f6f",
        "ShortName": "royoca",
        "FullName": "royoca",
        "LicenseType": 3
    },
    {
        "Id": "4ee8be0d-71f7-42b1-8760-f065230a3dd2",
        "ShortName": "BrewHavenOC",
        "FullName": "Brew Haven OC",
        "LicenseType": 3
    },
    {
        "Id": "396e414c-819c-4055-b17f-41a3dc1683ce",
        "ShortName": "BradOC",
        "FullName": "BradOC",
        "LicenseType": 3
    },
    {
        "Id": "b3745cf9-dd98-4190-9e57-ec0768da5281",
        "ShortName": "BBOC2",
        "FullName": "BBOC2",
        "LicenseType": 3
    },
    {
        "Id": "468062ab-ec6f-4e7c-b423-27a80a3fbe6e",
        "ShortName": "Ran_Yachts_OC",
        "FullName": "Ran_Yachts_OC",
        "LicenseType": 3
    },
    {
        "Id": "267a04d7-efab-4ab1-a02c-0a76c8ed006f",
        "ShortName": "BBOC745",
        "FullName": "BBOC745",
        "LicenseType": 3
    },
    {
        "Id": "32b86111-616b-4e40-b1fb-78c97ad9b83a",
        "ShortName": "ActiveComsOC",
        "FullName": "ActiveCommunications OC",
        "LicenseType": 3
    },
    {
        "Id": "5787d31f-cfba-4621-9d7f-11c301372d5a",
        "ShortName": "AudioCodesUS",
        "FullName": "AudioCodes US M365",
        "LicenseType": 3
    }
]

HTTP Responses

■ 200 OK

Parameter

Type

Description

Id

string

'umpCustomerGuid' value created in the Live Platformcustomer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Customer from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Essentials Customer.

This value is also obtained in the 'Get Task' response when the customer is created.

shortName

string

Short name of service complying with the following validation rules:

■ The string should be 3-15 characters long
■ The following characters cannot be used: \ / : * ? " < > |audit
■ Can contain letters (lower/UPPER case), Numbers and special characters are allowed, however cannot contain the dot (.) or blank spaces.
■ Unique name per M365 Tenant

fullName

string

The full name of the service defined upon service creation.

licenseType

integer Enum:

[3, 4, 5]

[ 0, 1, 2]

One of the following values:

■ Hosted Essentials: 0
■ Hosted Essential Plus: 1
■ Hosted Pro: 2
■ OC Essential: 3
■ OC Essential Plus: 4
■ OC Pro: 5